home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmCreateOptionMenu.z / XmCreateOptionMenu
Encoding:
Text File  |  2002-10-03  |  9.6 KB  |  199 lines

  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu - A RowColumn widget convenience creation
  10.           function
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////RRRRoooowwwwCCCCoooolllluuuummmmnnnn....hhhh>>>>
  14.  
  15.           WWWWiiiiddddggggeeeetttt XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu ((((_p_a_r_e_n_t, _n_a_m_e, _a_r_g_l_i_s_t, _a_r_g_c_o_u_n_t))))
  16.                WWWWiiiiddddggggeeeetttt    _p_a_r_e_n_t;;;;
  17.                SSSSttttrrrriiiinnnngggg    _n_a_m_e;;;;
  18.                AAAArrrrggggLLLLiiiisssstttt   _a_r_g_l_i_s_t;;;;
  19.                CCCCaaaarrrrddddiiiinnnnaaaallll  _a_r_g_c_o_u_n_t;;;;
  20.  
  21.  
  22.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  23.           This page documents version 1.2 of the Motif library.
  24.  
  25.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  26.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu creates an instance of a RowColumn widget
  27.           of type XXXXmmmmMMMMEEEENNNNUUUU____OOOOPPPPTTTTIIIIOOOONNNN and returns the associated widget ID.
  28.  
  29.           It is provided as a convenience function for creating a
  30.           RowColumn widget configured to operate as an OptionMenu and
  31.           is not implemented as a separate widget class.
  32.  
  33.           The OptionMenu widget is a specialized RowColumn manager
  34.           composed of a label, a selection area, and a single Pulldown
  35.           MenuPane.  When an application creates an OptionMenu widget,
  36.           it supplies the label string and the Pulldown MenuPane.  In
  37.           order to succeed, there must be a valid XXXXmmmmNNNNssssuuuubbbbMMMMeeeennnnuuuuIIIIdddd
  38.           resource set when calling this function.  When the
  39.           OptionMenu is created, the Pulldown MenuPane must have been
  40.           created as a child of the OptionMenu's parent and must be
  41.           specified.  The LabelGadget and the selection area (a
  42.           CascadeButtonGadget) are created by the OptionMenu.
  43.  
  44.           The OptionMenu's Pulldown MenuPane must not contain any
  45.           ToggleButtons or ToggleButtonGadgets.  The results of
  46.           including CascadeButtons or CascadeButtonGadgets in the
  47.           OptionMenu's Pulldown MenuPane are undefined.
  48.  
  49.           An OptionMenu is laid out with the label displayed on one
  50.           side of the widget and the selection area on the other side
  51.           when XXXXmmmmNNNNoooorrrriiiieeeennnnttttaaaattttiiiioooonnnn is XmHORIZONTAL.  If the value is
  52.           XmVERTICAL, the label is above the selection area. The
  53.           selection area has a dual purpose; it displays the label of
  54.           the last item selected from the associated Pulldown
  55.           MenuPane, and it provides the means for posting the Pulldown
  56.           MenuPane.
  57.  
  58.           The OptionMenu typically does not display any 3-D visuals
  59.           around itself or the internal LabelGadget.  By default, the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           internal CascadeButtonGadget has a visible 3-D shadow.  The
  75.           application may change this by getting the
  76.           CascadeButtonGadget ID using XXXXmmmmOOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt, and then
  77.           calling XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss using the standard visual-related
  78.           resources.
  79.  
  80.           The Pulldown MenuPane is posted by moving the mouse pointer
  81.           over the selection area and pressing a mouse button defined
  82.           by OptionMenu's RowColumn parent.  The Pulldown MenuPane is
  83.           posted and positioned so that the last selected item is
  84.           directly over the selection area.  The mouse is then used to
  85.           arm the desired menu item.  When the mouse button is
  86.           released, the armed menu item is selected and the label
  87.           within the selection area is changed to match that of the
  88.           selected item.  By default, BBBBSSSSeeeelllleeeecccctttt is used to interact with
  89.           an OptionMenu.  The default can be changed via the RowColumn
  90.           resource XXXXmmmmNNNNmmmmeeeennnnuuuuPPPPoooosssstttt.
  91.  
  92.           The OptionMenu also operates by using the keyboard interface
  93.           mechanism.  If the application has established a mnemonic
  94.           with the OptionMenu, typing Alt with the mnemonic causes the
  95.           Pulldown MenuPane to be posted with traversal enabled.  The
  96.           standard traversal keys can then be used to move within the
  97.           MenuPane.  Selection can occur as the result of pressing the
  98.           Return key or typing a mnemonic or accelerator for one of
  99.           the menu items.
  100.  
  101.           An application may use the XXXXmmmmNNNNmmmmeeeennnnuuuuHHHHiiiissssttttoooorrrryyyy resource to
  102.           indicate which item in the Pulldown MenuPane should be
  103.           treated as the current choice and have its label displayed
  104.           in the selection area.  By default, the first item in the
  105.           Pulldown MenuPane is used.
  106.  
  107.  
  108.           _p_a_r_e_n_t Specifies the parent widget ID
  109.  
  110.           _n_a_m_e   Specifies the name of the created widget
  111.  
  112.           _a_r_g_l_i_s_tSpecifies the argument list
  113.  
  114.           _a_r_g_c_o_u_n_t
  115.                  Specifies the number of attribute/value pairs in the
  116.                  argument list (_a_r_g_l_i_s_t)
  117.  
  118.  
  119.           The user can specify resources in a resource file for the
  120.           automatically created widgets and gadgets of an OptionMenu.
  121.           The following list identifies the names of these widgets (or
  122.           gadgets) and the associated OptionMenu areas.
  123.  
  124.  
  125.             +o
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))    UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV    XXXXmmmmCCCCrrrreeeeaaaatttteeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX))))
  137.  
  138.  
  139.  
  140.             +o  Option Menu Label Gadget-"OptionLabel"
  141.  
  142.             +o  Option Menu Cascade Button-"OptionButton"
  143.  
  144.  
  145.           For a complete definition of RowColumn and its associated
  146.           resources, see XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))).
  147.  
  148.      RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE
  149.           Returns the RowColumn widget ID.
  150.  
  151.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  152.           XXXXmmmmCCCCaaaassssccccaaaaddddeeeeBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeePPPPuuuullllllllddddoooowwwwnnnnMMMMeeeennnnuuuu((((3333XXXX)))),
  153.           XXXXmmmmCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX)))), XXXXmmmmLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt((((3333XXXX)))),
  154.           XXXXmmmmOOOOppppttttiiiioooonnnnBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), XXXXmmmmOOOOppppttttiiiioooonnnnLLLLaaaabbbbeeeellllGGGGaaaaddddggggeeeetttt((((3333XXXX)))),
  155.           XXXXmmmmRRRRoooowwwwCCCCoooolllluuuummmmnnnn((((3333XXXX)))), and XXXXmmmmVVVVaaaaCCCCrrrreeeeaaaatttteeeeSSSSiiiimmmmpppplllleeeeOOOOppppttttiiiioooonnnnMMMMeeeennnnuuuu((((3333XXXX)))).
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.